/*******************************************************************************************
 * Copyright (c) 2006-2009 Alex Robson, Rob Simmons, Craig Israel, and Rachel Twyford
 *
 * Use of this software in any form requires that you have both 
 * read and agreed to the following terms:
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the "Software"), 
 * to deal in the Software without restriction, including without limitation 
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions: 
 *
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the 
 * documentation and/or other materials provided with the distribution.
 * Neither the name of Nvigorate nor the names of its contributors may 
 * be used to endorse or promote products derived from this software without 
 * specific prior written permission. 
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 * DISCLAIMED. IN NO EVENT SHALL ANY CONTRIBUTOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ****************************************************************************************/

using System;
using System.Collections.Generic;
using System.Data;

namespace Nvigorate.Data
{
    public interface IDatabaseCommand
    {
        IDbDataParameter this[string parameterName] { get; }
        void AbortTransaction();

        /// <summary>
        /// Starts a new transaction which all future commands which will be executed under until
        /// an Abort or CompleteTransaction is called.
        /// </summary>
        void BeginTransaction();

        void CompleteTransaction();
        DataTable BuildTable(IDataReader reader, string tableName);
        DataSet BuildSet(IDataReader reader, string datasetName, string[] tables);
        IEnumerable<T> ProcessReader<T>(IDbConnection connection, Func<IDataReader, IEnumerable<T>> process);
        DataSet GetDataSet(IDbConnection connection, string datasetName, string[] tables);
        DataTable GetDataTable(IDbConnection connection, string tableName);
        object GetScalar(IDbConnection connection);
        int Execute(IDbConnection connection, bool useTransactionScope);
        DataTable ExecuteWithTableResult(IDbConnection connection, bool useTransactionScope, string tableName);
        DataSet ExecuteWithSetResult(IDbConnection connection, bool useTransactionScope, string datasetName, string[] tables);
        T ExecuteCommand<T>(IDbConnection connection, bool useTransactionScope, Func<IDbCommand, T> commandWrapper);
        DataInterfaceException GetException(Exception ex);
        void SetParameters(IEnumerable<IDbDataParameter> parameters);
        void SetParameters(Dictionary<string, object> parameters);
        void SetParameters(object[] values);
    }
}